/* Copyright (c) 2010 Vinay Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.gwt.maps.client.directions;

import com.google.gwt.maps.client.HasJso;
import com.google.gwt.maps.client.base.HasLatLng;

/**
 * A DirectionsWaypoint represents a location between origin and destination
 * through which the trip should be routed.
 * 
 * @author vinay.sekhri@gmail.com (Vinay Sekhri)
 */
public interface HasDirectionsWaypoint extends HasJso {

  public String getLocationString();

  public HasLatLng getLocationLatLng();

  /**
   * Waypoint location. Can be an address string or LatLng. Optional.
   */
  public void setLocation(String location);

  /**
   * Waypoint location. Can be an address string or LatLng. Optional.
   */
  public void setLocation(HasLatLng point);

  public boolean isStopover();

  /**
   * If true, indicates that this waypoint is a stop between the origin and
   * destination. This has the effect of splitting the route into two. This
   * value is true by default. Optional.
   */
  public void setStopover(boolean isStopover);

}
